[]
        
在线Demo 免费试用
(Showing Draft Content)

K8s

K8s

[GET] /api/v2/admin/k8s/metrics

获取当前k8s部署的指标信息。

返回值

状态码: 200

成功

K8SPodMetricsDataModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

类型定义

Ƭ K8SPodMetricsDataModel

名称 类型 描述 示例
apiVersion可为空 string 定义对象表示的版本化模式。
kind可为空 string 定义此对象所代表的 REST 资源。
metadata V1ObjectMeta
items可为空 PodMetrics pod 指标列表。

Ƭ V1ObjectMeta

ObjectMeta 是所有持久化资源必须具备的元数据,其中包括 用户必须创建的所有对象。

名称 类型 描述 示例
annotations可为空 string 注释是与资源一起存储的非结构化键值映射,可以由外部工具设置以存储和检索任意元数据。它们不可查询,在修改对象时应保留。更多信息:
https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
creationTimestamp可为空 ISO DateTime Sting CreationTimestamp 是一个时间戳,表示此对象创建时的服务器时间。它不能保证在单独的操作中按发生顺序设置。客户端可能无法设置此值。它以 RFC3339 格式表示,并且采用 UTC 时间。由系统填充。只读。列表为空。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionGracePeriodSeconds可为空 int64 此对象在从系统中删除之前可正常终止的秒数。仅在设置了删除时间戳时才设置。只能缩短。只读。
deletionTimestamp可为空 ISO DateTime Sting DeletionTimestamp 是 RFC 3339 删除此资源的日期和时间。当用户请求正常删除时,服务器会设置此字段,客户端无法直接设置。一旦 finalizers 列表为空,则预计资源将在此字段中的时间之后被删除(不再显示在资源列表中,并且无法通过名称访问)。只要 finalizers 列表包含项目,就会阻止删除。一旦设置了 deleteTimestamp,则不能取消设置此值或将其设置为更远的时间,尽管可以缩短此值或在此时间之前删除资源。例如,用户可以请求在 30 秒内删除 pod。Kubelet 将通过向 pod 中的容器发送正常终止信号做出反应。 30 秒后,Kubelet 将向容器发送硬终止信号
(SIGKILL),并在清理后从 API 中删除 pod。在存在网络分区的情况下,此对象可能在此时间戳之后仍然存在,直到管理员或自动化流程可以确定资源已完全终止。如果未设置,则尚未请求正常删除对象。

当请求正常删除时由系统填充。只读。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
finalizers可为空 Array<string> 在从注册表中删除对象之前必须为空。每个条目都是负责组件的标识符,负责组件将从列表中删除该条目。如果对象的删除时间戳不为零,则只能删除此列表中的条目。可以按任何顺序处理和删除终结器。
不强制执行顺序,因为这会带来终结器卡住的重大风险。终结器是一个共享字段,任何有权限的参与者都可以对其进行重新排序。如果按顺序处理终结器列表,则这可能导致以下情况:负责列表中第一个终结器的组件正在等待负责列表中较后终结器的组件发出的信号(字段值、外部系统或其他),从而导致死锁。如果没有强制排序,终结器可以在它们之间自由排序,并且不易受到列表中排序更改的影响。
generateName可为空 string GenerateName 是可选前缀,仅当未提供 Name 字段时,服务器才会使用它来生成唯一名称。如果使用此字段,则返回给客户端的名称将与传递的名称不同。此值也将与唯一后缀相结合。提供的值具有与 Name 字段相同的验证规则,并且可能会被截断为使服务器上的值唯一所需的后缀长度。如果指定了此字段并且生成的名称存在,则服务器将返回 409。仅在未指定 Name 时适用。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generation可为空 int64 表示所需状态的特定代的序列号。
由系统填充。只读。
labels可为空 string 字符串键和值的映射,可用于组织和分类(范围和选择)对象。可能与复制控制器和服务的选择器匹配。更多信息:
https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
managedFields可为空 V1ManagedFieldsEntry ManagedFields 将工作流 ID 和版本映射到由该工作流管理的字段集。这主要用于内部管理,用户通常不需要设置或了解此字段。工作流可以是用户的名称、控制器的名称或特定应用路径的名称,如“ci-cd”。字段集始终位于工作流修改对象时使用的版本中。
name可为空 string 名称在命名空间内必须是唯一的。创建资源时需要此名称,
尽管某些资源可能允许客户端自动请求生成
适当的名称。名称主要用于创建
和配置定义。无法更新。更多信息:
https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
namespaceProperty可为空 string 命名空间定义每个名称必须是唯一的空间。空的
命名空间相当于“默认”命名空间,但“默认”是
规范表示。并非所有对象都需要限定在
命名空间内 - 这些对象的此字段值将为空。

必须是 DNS_LABEL。无法更新。更多信息:
https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
ownerReferences可为空 V1OwnerReference 此对象所依赖的对象列表。如果列表中的所有对象都已删除,则此对象将被垃圾回收。如果此对象由控制器管理,则此列表中的条目将指向此控制器,并将控制器字段设置为 true。管理控制器不能超过一个。
resourceVersion可为空 string 一个不透明值,表示此对象的内部版本,客户端可以使用它来确定对象何时发生更改。可用于乐观并发、更改检测和对资源或资源集的监视操作。客户端必须将这些值视为不透明的,并将其不加修改地传回服务器。它们可能仅对特定资源或资源集有效。由系统填充。只读。客户端必须将值视为不透明的。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
selfLink可为空 string 已弃用:selfLink 是旧的只读字段,系统不再填充该字段。
uid可为空 string UID 是此对象在时间和空间中的唯一值。它通常由服务器在成功创建资源时生成,并且不允许在 PUT 操作中更改。

由系统填充。只读。更多信息:
https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Ƭ PodMetrics

描述从指标服务器 API 中提取的 pod 资源使用情况指标。

名称 类型 描述 示例
metadata V1ObjectMeta
timestamp可为空 ISO DateTime Sting 收集指标的时间戳。
window可为空 string 收集指标的时间间隔。
containers可为空 ContainerMetrics 容器指标列表。

Ƭ V1ManagedFieldsEntry

ManagedFieldsEntry 是一个工作流 ID、一个 FieldSet 和该 fieldset 适用的资源的组版本。

名称 类型 描述 示例
apiVersion可为空 string APIVersion 定义此字段集适用的资源版本。
其格式与顶级 APIVersion 字段一样为“group/version”。
必须跟踪字段集的版本,因为它无法自动
转换。
fieldsType可为空 string FieldsType 是不同字段格式和版本的鉴别器。
目前只有一个可能的值:“FieldsV1”
fieldsV1可为空 any FieldsV1 保存“FieldsV1”
type 中描述的第一个 JSON 版本格式。
manager可为空 string 管理器是管理这些字段的工作流的标识符。
operation可为空 string 操作是导致创建此 ManagedFieldsEntry 的操作类型。此字段的唯一有效值是“应用”和“更新”。
subresource可为空 string Subresource 是用于更新该对象的子资源的名称,如果对象是通过主资源更新的,则为空字符串。此字段的值用于区分管理器,即使它们共享相同的名称。例如,状态更新将不同于使用相同管理器名称的常规更新。请注意,APIVersion 字段与 Subresource 字段无关,并且它始终与主资源的版本相对应。
time可为空 ISO DateTime Sting 时间是添加 ManagedFields 条目时的时间戳。如果添加字段、管理员更改任何拥有的字段值或删除字段,时间戳
也会更新。如果由于另一个管理员接管而从条目中删除字段,时间戳
不会更新。

Ƭ V1OwnerReference

OwnerReference 包含足够的信息来让您识别拥有对象。 拥有对象必须与依赖对象位于同一命名空间中,或属于 群集范围,因此没有命名空间字段。

名称 类型 描述 示例
apiVersion可为空 string 所引用的 API 版本。
blockOwnerDeletion可为空 Boolean 如果为 true,并且所有者具有“foregroundDeletion”终结器,则在删除此引用之前,所有者
不能从键值存储中删除。请参阅
https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
了解垃圾收集器如何与此字段交互并强制执行
前台删除。默认为 false。要设置此字段,用户需要所有者的“删除”
权限,否则将返回 422(无法处理的实体)。
controller可为空 Boolean 如果为真,则此引用指向管理控制器。
kind可为空 string 参考类型。更多信息:
https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
name可为空 string 引用对象的名称。更多信息:
https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
uid可为空 string 引用对象的 UID。更多信息:
https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Ƭ ContainerMetrics

描述从指标服务器 API 中提取的容器资源使用情况指标。

名称 类型 描述 示例
name可为空 string 定义与 pod.spec.containers 中对应的容器名称。
usage可为空 string 资源使用情况。

Ƭ ServerPluginError

服务器插件错误

名称 类型 描述 示例
code可为空 string 错误代码
message可为空 string 错误信息
context可为空 string 错误上下文
innerError ServerPluginError
extensions可为空 any 扩展结果